Index
© 2006 - 2013 Ekahau, Inc.
| cfg-service supports 33 commands: | Services: pos eve edp status route sensor msg cfg asset mod map sys tftp eng tag rec aprec test index |
| /epe/cfg/batteryhistory POST version | Input: | Output: | |
|
Description:
Lists battery history for devices. Example 1: List 10 latest battery levels of tag 00:11:22:33:44:55:66
Role Required:
viewer
|
tagid (optional) - [Array] list entries related to specific devices, specified by device ids
mac (optional) - [Array] list entries related to specific devices, specified by MAC addresses assetid (optional) - [Array] list entries related to specific assets, specified by asset ids since (optional) - [String] list entries since the specified time. there are two alternative formats; the point of time can be given as milliseconds elapsed since midnight UTC of January 1, 1970. another option is to use the ISO 8601 notation (yyyy-MM-dd hh:mm:ssZ). time zone is optional; if it's omitted, the input is interpreted as server's local time until (optional) - [String] list entries until the specified time. format is the same as with since sort (optional) - [String] sorts output into given order. Allowed values are 'ascending' and 'descending'. Can not be used simultaneously with 'numlatest' or 'numoldest' streaming (optional) - [String] if set to true, returns history as a stream numlatest (optional) - [int] max number of entries to list, newest first numoldest (optional) - [int] max number of entries to list, oldest first |
BATTERY.tagid - [long] id of the tag
BATTERY.mac - [String] mac address of the tag BATTERY.asset - [long] asset id (optional) BATTERY.time - [long] battery level time stamp as milliseconds elapsed since midnight UTC of January 1, 1970 BATTERY.timestamp - [String] battery level time stamp as string BATTERY.battery - [int] battery level, 0-100 BATTERY.charging - [String] true or false |
|
| /epe/cfg/filedelete POST version | Input: | Output: | |
|
Description:
Delete a file from the RTLS Controller database. Example 1: Delete a file with id 1
Role Required:
poweruser
|
fileid (required) - [long] file id
|
||
| /epe/cfg/filedownload POST version | Input: | Output: | |
|
Description:
Downloads a file either as BASE64 encoded XML or in native format. Example 1: Download a file with id 1 as XML. The BASE64 encoded file is in data_b field. Example 2: Download a file with id 1 as native
Role Required:
poweruser
|
fileid (required) - [long] file id
format (optional) - [String] set to native to download file as native |
FILE.fileid - [long] file id
FILE.name - [String] filename FILE.uploadedon - [String] file upload time FILE.size - [int] file size in bytes FILE.type - [String] file type, such as license or firmware FILE.data_b - [bin] file contents |
|
| /epe/cfg/filelist POST version | Input: | Output: | |
|
Description:
List all files uploaded to the server. Example 1: List all files Example 2: List all T201 firmware files
Role Required:
viewer
|
type (optional) - [Array] show only files of this type
|
FILE.fileid - [long] file id
FILE.name - [String] filename FILE.uploadedon - [String] file upload time FILE.size - [int] file size in bytes FILE.type - [String] file type, such as license or firmware FILE.description - [String] file description |
|
| /epe/cfg/fileupload POST version | Input: | Output: | |
|
Description:
Upload a file to the system. The file content must be encoded with base64. Four different kind of files are supported. To get the factory default normalization file, set type to 'normalization' and do not provide data_b. Uploading a normalization file causes restart of the positioning system. Example 1: Create a bogus firmware file with name 'test', containing 'hello there!'
Role Required:
poweruser
|
name (required) - [String] filename
type (required) - [String] file type. Values are [firmware; firmware301; license; normalization]. data_b (optional) - [bin] base64 encoded data |
FILE.fileid - [long] file id
FILE.name - [String] filename FILE.uploadedon - [String] file upload time FILE.size - [int] file size in bytes FILE.type - [String] file type, such as license or firmware |
|
| /epe/cfg/firmwarelist POST version | Input: | Output: | |
|
Description:
List all firmware files uploaded to the server. Example 1: List all firmwares
Role Required:
viewer
|
type (optional) - [String] show only firmwares of this type (or "all")
|
FILE.fileid - [long] file id
FILE.name - [String] filename FILE.uploadedon - [String] file upload time FILE.size - [int] file size in bytes FILE.type - [String] firmware type FILE.description - [String] firmware description FILE.version - [String] firmware version FILE.date - [String] firmware date |
|
| /epe/cfg/tagaddtogroups POST version | Input: | Output: | |
|
Description:
Add group memberships to a tag. Differs from tagsetgroups by keeping existing memberships, i.e. does not remove tag from any groups. Example 1: Add tag 344 to groups 610 & 615
Role Required:
tagoperator
|
taggroupid (required) - [Array] array of tag group ids to add tag to
tagid (optional) - [long] tag id mac (optional) - [String] MAC address of the device |
||
| /epe/cfg/tagbatteryestimate POST version | Input: | Output: | |
|
Description:
Estimates tag battery lifetime with the given configuration. Returns all of the input parameters in the return message, plus the calculated estimate. This way a configuration draft does not need to be saved before an estimate is calculated (the returned data can be filled back to a form that was posted). The command may return different results for several subtypes of tags (e.g. different firmware versions).
Role Required:
viewer
|
name (optional) - [String] name of the config
description (optional) - [String] description of the config type (optional) - [String] config device type (t201, t301, t301i, ec4, ts1, ts1v3, ts2, ts2v3, ts-c, hs1); default is t301 cmd (optional) - [Array] commands for the config movefreq (optional) - [int] estimate of how often a tag with this configuration moves, given as times per day moveduration (optional) - [int] estimate of how long an average movement occasion takes for a tag with this configuration, given as seconds |
BATTERYESTIMATE.estimatetagtype - [Array] array of string keys denoting tag subtypes for which battery lifetime estimates are returned
BATTERYESTIMATE.estimatevalue - [Array] array of integers containing battery lifetime estimates for the tag subtypes given in estimatetagtype; time unit is hours BATTERYESTIMATE.name - [String] the same value given as input BATTERYESTIMATE.description - [String] the same value given as input BATTERYESTIMATE.type - [String] the same value given as input BATTERYESTIMATE.cmd - [Array] the same value given as input BATTERYESTIMATE.movefreq - [int] the same value given as input BATTERYESTIMATE.moveduration - [int] the same value given as input BATTERYESTIMATE.inputvariable - [Array] descriptions of variables used in estimation BATTERYESTIMATE.inputvariablevalue - [Array] descriptions of the variable values used in estimation |
|
| /epe/cfg/tagcommandadd POST version | Input: | Output: | |
|
Description:
Adds commands for a tag. Commands are not sent immediately; they are appended to the end of the tag private command queue, waiting there until the tag contacts the RTLS Controller. Returns a list of currently pending private commands. If no command is given, just returns pending commands. T201 'swupdate' command requires atleast poweruser role! T301 and T201 tags have different set of commands. Please consult tag guides for the list of valid commands for each tag type. T301 commands are validated; returns error 654 if a command is invalid. Note that older T301 may not support newer T301 commands. If a command is valid but not supported by this T301, the call succeeds but the command is ignored. T201 commands are not validated by the RTLS Controller. They are sent as is to T201 which will validate them. T301 firmware update command, 'tu', must be sent as a sole command. Sending 'tu' clears any earlier pending commands. If a command clashes with the current configuration of a tag, the tag's configuration status is cleared. In this case a CLEAREDCONFIG message specifying the overridden configuration is returned. Example 1: See pending commands of tag 900. Example 2: Command T201 tag 900 to play buzzer for 2 seconds. Example 3: Command T201 tag 900 to blink led for 10 seconds. Example 4: Command T301 tag 900 to alarm once.
Role Required:
tagoperator
|
tagid (optional) - [Array] ids of the tags
mac (optional) - [Array] MACs of the tags cmd (optional) - [Array] new commands for the tag; appended to the queue |
COMMANDS.cmd - [Array] pending commands
IGNORED.cmd - [Array] ignored commands; commands that this T301 does not support because of an older command set CLEARED.cmd - [Array] cleared commands; when 'tu' is sent, earlier pending commands are cleared CLEAREDCONFIG.configid - [long] if a configuration was cleared as a result of the added commands, id of the cleared config CLEAREDCONFIG.name - [String] config name CLEAREDCONFIG.description - [String] description of the config CLEAREDCONFIG.modified - [String] modification time of the config CLEAREDCONFIG.type - [String] type of tag that this config is for CLEAREDCONFIG.cmd - [Array] commands for the config IGNOREDTAGS.tagid - [Array] ids of tags for which the commands could not be added IGNOREDTAGS.mac - [Array] equivalent to tagid, provides MAC addresses instead of tagids |
|
| /epe/cfg/tagcommandclear POST version | Input: | Output: | |
|
Description:
Clears pending private commands of a tag. If there are pending commands from a configuration, those commands are NOT cleared. Example 1: Clear pending private commands of tag 900.
Role Required:
tagoperator
|
tagid (optional) - [long] tag id
mac (optional) - [String] MAC address of the device |
||
| /epe/cfg/tagcommandlist POST version | Input: | Output: | |
|
Description:
Returns a list of all pending commands for the tag. Commands may come from three different "mailboxes": private commands, tag config commands, and menu commands (for display tags). The list is divided into three parts accordingly. Example 1: get commands for tag with id 1234
Role Required:
viewer
|
tagid (optional) - [long] tag id
mac (optional) - [String] MAC address of the device |
CONFIG.name - [String] name of the config mailbox
CONFIG.cmd - [Array] commands in the config mailbox MENU.name - [String] name of the menu mailbox MENU.cmd - [Array] commands in the menu mailbox PRIVATE.name - [String] name of the private mailbox PRIVATE.cmd - [Array] commands in the private mailbox |
|
| /epe/cfg/tagconfigcreate POST version | Input: | Output: | |
|
Description:
Create a new config that contains configuration commands for tags. Validates T301 commands; returns error 654 if a command is not valid. T201 commands are not validated. Example 1: Create a config containing two commands: 'sleep 3' and 'scanmenow' Example 2: Create a config containing three commands: 'se 4', 'sm 0' and 'sd 5' and with additional data for battery lifetime estimation: movement once per 30min = 48 times per day, average movement duration=2min
Role Required:
poweruser
|
name (required) - [String] name of the config
description (optional) - [String] description of the config type (optional) - [String] config device type (t201, t301, t301i, ec4, ts1, ts1v3, ts2, ts2v3, ts-c, hs1); default is t201 cmd (optional) - [Array] commands for the config movefreq (optional) - [int] estimate of how often a tag with this configuration moves, given as times per day; used in battery lifetime estimation moveduration (optional) - [int] estimate of how long an average movement occasion takes for a tag with this configuration, given as seconds; used in battery lifetime estimation predefinedconfig (optional) - [String] true if this is a predefied configuration, default false (user created configuration) |
CONFIG.configid - [long] id of the newly created config
CONFIG.cmd - [Array] commands of the newly created config |
|
| /epe/cfg/tagconfigdelete POST version | Input: | Output: | |
|
Description:
Delete a config. Example 1: Delete a config with id 10
Role Required:
poweruser
|
configid (required) - [long] config id
|
||
| /epe/cfg/tagconfigdump POST version | Input: | Output: | |
|
Description:
View configuration dump (it's active configuration) from a tag. A tag may not have been provided its configuration dump if it has not been requested. A dump is requested by sending tag command 'sendconfig'. Example 1: get config dump of tag with id 1234
Role Required:
viewer
|
tagid (optional) - [long] tag id
mac (optional) - [String] MAC address of the device |
TAGCONFIG.timestamp - [String] time of latest tag memory dump
TAGCONFIG.item - [Array] configuration dump items |
|
| /epe/cfg/tagconfigedit POST version | Input: | Output: | |
|
Description:
Edit a config. New commands replace old ones, if they are given. Validates T301 commands; returns error 654 if a command is not valid. T201 commands are not validated. Example 1: Set new commands for config 10 Example 2: Edit name of config 10 Example 3: Clear all commands of config 10
Role Required:
poweruser
|
configid (required) - [long] config id
name (optional) - [String] config name description (optional) - [String] description of the config cmd (optional) - [Array] commands for the config movefreq (optional) - [int] estimate of how often a tag with this configuration moves, given as times per day; used in battery lifetime estimation moveduration (optional) - [int] estimate of how long an average movement occasion takes for a tag with this configuration, given as seconds; used in battery lifetime estimation |
CONFIG.configid - [long] config id
CONFIG.name - [String] config name CONFIG.description - [String] description of the config CONFIG.cmd - [Array] commands for the config if any |
|
| /epe/cfg/tagconfiggetdefault POST version | Input: | Output: | |
|
Description:
Get default config for new tags that contact the system. Example 1: Default config for T301B tags
Role Required:
viewer
|
type (optional) - [String] config device type (t201, t301a, t301b, t301w, t301i, a4, b4, ec4, ts1, ts1v3, ts2, ts2v3, ts-c, hs1); default is t201
|
CONFIG.configid - [long] config id
CONFIG.name - [String] config name CONFIG.description - [String] description of the config CONFIG.modified - [String] modification time of the config CONFIG.type - [String] type of tag that this config is for CONFIG.predefinedconfig - [Array] true if this is a predefied configuration, false if user created configuration CONFIG.cmd - [Array] commands for the config |
|
| /epe/cfg/tagconfiglist POST version | Input: | Output: | |
|
Description:
List all or a specific config. Ordered by type, name. Example 1: List all configs Example 2: List config 10 Example 3: List configs for T301
Role Required:
viewer
|
configid (optional) - [long] config id
type (optional) - [String] type of configs to list: (t201, t301, t301i, ec4, ts1, ts1v3, ts2, ts2v3, ts-c, hs1) |
CONFIG.configid - [long] config id
CONFIG.name - [String] config name CONFIG.description - [String] description of the config CONFIG.modified - [String] modification time of the config CONFIG.type - [String] type of tag that this config is for CONFIG.predefinedconfig - [Array] true if this is a predefied configuration, false if user created configuration CONFIG.cmd - [Array] commands for the config CONFIG.movefreq - [int] estimate of how often a tag with this configuration moves, given as times per day; used in battery lifetime estimation CONFIG.moveduration - [int] estimate of how long an average movement occasion takes for a tag with this configuration, given as seconds; used in battery lifetime estimation |
|
| /epe/cfg/tagconfigsetdefault POST version | Input: | Output: | |
|
Description:
Set a default config for new tags that contact the system. Omit the id to remove default config. Example 1: New T201 tags will be associated with config 10 Example 2: New T301A tags will be associated with config 11 Example 3: New T301W tags will be associated with config 11 Example 4: Unset default T201 config; New T201 tags are associated with no config.
Role Required:
poweruser
|
configid (optional) - [long] config id; if not given, default config is unset
type (optional) - [String] config device type (t201, t301a, t301b, t301w, t301i, a4, b4, ec4, ts1, ts1v3, ts2, ts2v3, ts-c, hs1); default is t201 |
||
| /epe/cfg/tagdelete POST version | Input: | Output: | |
|
Description:
Deletes a tag from the database. Example 1: Delete tag with id 1234
Role Required:
tagoperator
|
tagid (optional) - [Array] tag ids
mac (optional) - [Array] MAC addresses of the devices |
||
| /epe/cfg/tagerrorcommandclear POST version | Input: | Output: | |
|
Description:
Clears error command. Example 1: Clear error command for tag 900.
Role Required:
tagoperator
|
tagid (optional) - [long] tag id
mac (optional) - [String] MAC address of the device |
||
| /epe/cfg/taggetcapabilities POST version | Input: | Output: | |
|
Description:
Lists the capabilities that each of the requested tags has. Each capability is represented by a string, e.g. "messaging" means that the tag is capable of displaying messages sent to it.
Role Required:
viewer
|
tagid (optional) - [Array] ids of the tags to be listed
mac (optional) - [Array] MAC addresses of the tags to be listed |
TAGCAPABILITIES.tagid - [long] tag id
TAGCAPABILITIES.mac - [String] tag MAC address TAGCAPABILITIES.capability - [Array] each string in the array represents a specific capability. possible values are: menu=a menu with user-selectable options can be set to the tag; messaging=the tag is capable of receiving messages and displaying them to the user |
|
| /epe/cfg/taggroupcreate POST version | Input: | Output: | |
|
Description:
Create a new tag group. Groups whose name starts with '_' are considered hidden and not displayed in the web administration. Example 1: Create a new group with name 'MyTagGroup'
Role Required:
tagoperator
|
name (required) - [String] name of the tag group
description (optional) - [String] description |
TAGGROUP.taggroupid - [long] tag group id
TAGGROUP.name - [String] name of the tag group TAGGROUP.description - [String] description TAGGROUP.createdon - [String] tag group create time TAGGROUP.modifiedon - [String] tag group modification time |
|
| /epe/cfg/taggroupdelete POST version | Input: | Output: | |
|
Description:
Delete a tag group. The tags are not deleted; only membership is removed. Example 1: Delete tag group 1
Role Required:
tagoperator
|
taggroupid (required) - [long] tag group id
|
||
| /epe/cfg/taggroupedit POST version | Input: | Output: | |
|
Description:
Edit tag group properties. Example 1: Edit name of tag group 1
Role Required:
tagoperator
|
taggroupid (required) - [long] tag group id
name (optional) - [String] name of the tag group description (optional) - [String] description |
||
| /epe/cfg/taggrouplist POST version | Input: | Output: | |
|
Description:
Lists tag groups. Ordered by name. Example 1: List tag group 1
Role Required:
viewer
|
taggroupid (optional) - [long] tag group id
|
TAGGROUP.taggroupid - [long] tag group id
TAGGROUP.name - [String] name of the tag group TAGGROUP.description - [String] description TAGGROUP.createdon - [String] tag group create time TAGGROUP.modifiedon - [String] tag group modification time |
|
| /epe/cfg/tagremovefromgroups POST version | Input: | Output: | |
|
Description:
Remove group memberships from a tag. Example 1: Remove tag 344 from groups 610 & 615
Role Required:
tagoperator
|
taggroupid (required) - [Array] array of tag group ids to add tag to
tagid (optional) - [long] tag id mac (optional) - [String] MAC address of the device |
||
| /epe/cfg/tagsetattribute POST version | Input: | Output: | |
|
Description:
Add or modify an attribute (a key-value pair) related to a device. If the device already has an attribute with the given key, its value is overwritten by the new value. An attribute can be deleted by making a call with value left null. Use /epe/pos/taglist to query a device's attributes. Example 1: Add attribute [icon=nurse.png] to tag 1 Example 2: Delete attribute with key "icon" from tag 1
Role Required:
tagoperator
|
key (required) - [String] attribute key
tagid (optional) - [long] id of the device mac (optional) - [String] MAC address of the device value (optional) - [String] attribute value |
TAGATTRIBUTE.attributeid - [long] unique id of the attribute
TAGATTRIBUTE.tagid - [long] id of the device TAGATTRIBUTE.key - [String] attribute key TAGATTRIBUTE.value - [String] attribute value |
|
| /epe/cfg/tagsetconfig POST version | Input: | Output: | |
|
Description:
Associate a config with a tag. Give 0 as configid to remove config association. The type of tag must be same as type of config. This is asserted by the command. Example 1: Associate config id 10 with tag 1234 Example 2: Unset config of tag 1234
Role Required:
tagoperator
|
configid (required) - [long] config id, 0 will unset the association
tagid (optional) - [long] tag id mac (optional) - [String] MAC address of the device |
||
| /epe/cfg/tagsetgroups POST version | Input: | Output: | |
|
Description:
Set group memberships of a tag. Tag may belong to any number of groups. You can list tag membership with taglist call. Example 1: Set tag 344 to groups 610 & 615 Example 2: Remove tag 344 from all groups
Role Required:
tagoperator
|
taggroupid (required) - [Array] array of tag group ids; if not specified, removes tag from all groups
tagid (optional) - [long] tag id mac (optional) - [String] MAC address of the device |
||
| /epe/cfg/tagsetname POST version | Input: | Output: | |
|
Description:
Set name, profile or custom data of a tag. The custom field can be used for any application data. It can hold 50 chars of data. Example 1: Set name and profile of tag 56
Role Required:
tagoperator
|
tagid (optional) - [long] tag id
mac (optional) - [String] MAC address of the device name (optional) - [String] name of tag profile (optional) - [String] profile of the tag custom (optional) - [String] user specified data |
||
| /epe/cfg/_clear | Input: | Output: | |
|
Description:
SPECIAL. Resets all service specific counters.
Role Required:
poweruser
|
|||
| /epe/cfg/_list POST version | Input: | Output: | |
|
Description:
SPECIAL. Lists the available commands, their arguments, responses, required roles, call counters and optional help descriptions.
Role Required:
|
help (optional) - [int] set to 1 to get also HTML help description of the commands. Default is 0.
|
COMMAND.name - [String] command name
COMMAND.arg - [String] mandatory argument COMMAND.optarg - [String] optional argument COMMAND.response - [String] response field COMMAND.internal - [int] 1 for internal command COMMAND.role - [String] required role COMMAND.callcount - [int] number of calls COMMAND.callcountinternal - [int] number of internal calls COMMAND.callcountfailure - [int] number of failed calls COMMAND.htmlhelp - [String] command description in HTML format |
|
| /epe/cfg/_status | Input: | Output: | |
|
Description:
SPECIAL. Returns status information about the service.
Role Required:
viewer
|
STATUS.callcount - [int] total number of calls for the service
STATUS.callcountinternal - [int] total number of internal calls for the service STATUS.callcountfailure - [int] total number of failed calls for the service STATUS.commandcount - [int] number of commands in service STATUS.* - [String] service specific status information |
||
(The data in this page was generated from /epe/cfg/_list?help=1)